Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: use embedded build for preview examples #3343

Open
wants to merge 4 commits into
base: next
Choose a base branch
from

Conversation

ST-DDT
Copy link
Member

@ST-DDT ST-DDT commented Dec 28, 2024

Fixes #3342, #3301 (comment)


This bundles the project into a single file and makes it available to the browser console for next and PRs.
To keep traffic low on our website and help counting the usage of the versions, the release sites keep using the jsdelivr CDN links.

You can test it using the new language method.

grafik

grafik
grafik

@ST-DDT ST-DDT added c: docs Improvements or additions to documentation p: 1-normal Nothing urgent labels Dec 28, 2024
@ST-DDT ST-DDT added this to the vAnytime milestone Dec 28, 2024
@ST-DDT ST-DDT requested review from a team December 28, 2024 13:58
@ST-DDT ST-DDT self-assigned this Dec 28, 2024
Copy link

netlify bot commented Dec 28, 2024

Deploy Preview for fakerjs ready!

Name Link
🔨 Latest commit 9873c59
🔍 Latest deploy log https://app.netlify.com/sites/fakerjs/deploys/6778196225a1190008eabdb5
😎 Deploy Preview https://deploy-preview-3343.fakerjs.dev
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

codecov bot commented Dec 28, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.97%. Comparing base (ece4f16) to head (9873c59).

Additional details and impacted files
@@            Coverage Diff             @@
##             next    #3343      +/-   ##
==========================================
- Coverage   99.97%   99.97%   -0.01%     
==========================================
  Files        2811     2811              
  Lines      217023   217023              
  Branches      942      941       -1     
==========================================
- Hits       216972   216970       -2     
- Misses         51       53       +2     

see 1 file with indirect coverage changes

package.json Outdated Show resolved Hide resolved
tsup.config.ts Outdated Show resolved Hide resolved
@matthewmayer
Copy link
Contributor

This appears to fix jwt() too - although I'm not sure why it fails as that was added in 9.1.0... https://next.fakerjs.dev/api/internet.html#jwt

image

@ST-DDT
Copy link
Member Author

ST-DDT commented Dec 28, 2024

Thats caused by the bad Buffer polyfil. Not sure where we discussed that.

EDIT:

@ST-DDT ST-DDT linked an issue Dec 28, 2024 that may be closed by this pull request
10 tasks
This was referenced Jan 2, 2025
Copy link
Member

@xDivisionByZerox xDivisionByZerox left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you extend the [CONTRIBUTING page] with the new script as well?

package.json Outdated Show resolved Hide resolved
tsup.config.ts Outdated Show resolved Hide resolved
@ST-DDT
Copy link
Member Author

ST-DDT commented Jan 3, 2025

Could you extend the [CONTRIBUTING page] with the new script as well?

The other doc scripts aren't listed there either and IMO the command isn't supposed to be called by anybody directly.

@ST-DDT ST-DDT requested review from Shinigami92, xDivisionByZerox and a team January 3, 2025 17:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c: docs Improvements or additions to documentation p: 1-normal Nothing urgent
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Refresh examples button doesn't work for unreleased methods internet.jwt() fails on documentation website
4 participants